@figspec/components

Unofficial Figma spec viewer: Live Embed Kit - Live + Guidelines + Inspector

1.0.3
Source
npm

Version published: 10 months ago

Weekly downloads: 698K; increased by9.03%

Maintainers: 1

Weekly downloads

Created: 4 years ago

Source

@figspec/components

CustomElements renders given Figma API's result into a rich preview.

Installation

$ yarn add @figspec/components

# or

$ npm i @figspec/components

Usage

Import the entry script (import '@figspec/components') and it'll register our custom elements. Then you can now use these on your page.

// your script.js
import "@figspec/components";

// ...

<body>
  <figspec-frame-viewer nodes="..." rendered-image="..."></figspec-frame-viewer>
</body>

To display an entire Figma File, use <figspec-file-viewer> instead.

<body>
  <figspec-file-viewer
    document-node="..."
    rendered-images="..."
  ></figspec-file-viewer>
</body>

To see examples and API docs, please check out docs site.

NOTE: We don't provide bundled scripts yet. If you want to put the script in head tag, please build the files at your own.

TypeScript support

This package ships with TypeScript definition file.

One of our "typing dependencies" is missing from package.json#dependencies, because it's not our "runtime dependency". So, you need to install that package in order to get full types (otherwise some properties turns into any).

# By installing this package, FileNode related properties will get correct types.
yarn add -D figma-js

Browser supports

Browsers supporting WebComponents v1 spec and ES2015 or later. The bundled codes are emitted under esm/es2015 and cjs/es2016.

@figspec/react ... React bindings for this package.

Keywords

FAQs

What is @figspec/components?

Is @figspec/components popular?

Is @figspec/components well maintained?

Package last updated on 05 Jan 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install